/*******************************************************************************
 * Copyright 2009, 2010 Innovation Gate GmbH. All Rights Reserved.
 * 
 * This file is part of the OpenWGA server platform.
 * 
 * OpenWGA is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * In addition, a special exception is granted by the copyright holders
 * of OpenWGA called "OpenWGA plugin exception". You should have received
 * a copy of this exception along with OpenWGA in file COPYING.
 * If not, see <http://www.openwga.com/gpl-plugin-exception>.
 * 
 * OpenWGA is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with OpenWGA in file COPYING.
 * If not, see <http://www.gnu.org/licenses/>.
 ******************************************************************************/

package de.innovationgate.webgate.api;

/**
 * Interface for WGAPI transactions. Create via {@link WGDatabase#startTransaction()}
 */
public interface WGTransaction {
    
    /**
     * Commit the transaction
     * @return true if a transaction was actually committed. false if this is a cascaded transaction and there is an outer physical transaction not yet committed.
     * @throws WGAPIException
     */
    public boolean commit() throws WGAPIException;
    
    /**
     * Roll the transaction back.
     */
    public void rollback();
    
    /**
     * Identifies if this transaction is still open.
     * Must be false after the transaction has been committed or rolled back. 
     * @throws WGAPIException
     */
    public boolean isOpen();


}
